Returns a handle to a component’s icon suite to your application.

OSErr GetComponentIconSuite (
    Component aComponent, 
    Handle *iconSuite
);

Parameter descriptions

aComponent

The component whose icon suite you wish to obtain. Your application obtains a component identifier from the FindNextComponent function. If your application registers a component, it can also obtain a component identifier from the RegisterComponent or RegisterComponentResource function. You can use a component instance here, but you must coerce the data type appropriately.

iconSuite

On return, a pointer to a handle for the component’s icon suite or, if the component has not provided an icon suite, NULL. A component provides the resource ID of its icon family to the Component Manager in the optional extensions to the component resource. Your application is responsible for disposing of the returned icon suite handle.

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)